Introdução à API de nota fiscal
A Myse API foi criada pensando em automatizar e simplificar a emissão de Nota Fiscal Eletrônica (NFe) e Nota Fiscal do Consumidor Eletrônica (NFCe) de nossos parceiros.
Ela pode ser usada em conjunto com sistemas já existentes (como ERPs, plataformas de e-commerce, etc.), apenas requisitando os recursos necessários e transferindo para ela toda a responsabilidade de emissão e comunicação com o Sefaz.
Trabalhamos com a persistência de clientes, produtos e configurações fiscais, dessa forma a emissão de documentos fiscais fica ainda mais fácil.
Nossa documentação busca detalhar e explanar todos os recursos, mas caso alguma dúvida surja, entre em contato conosco.
Padronização
Nossa API foi projetada utilizando o conceito de serviços REST, charset UTF-8 e formato JSON para troca de mensagens (requisição e resposta).
| Tecnologia | Descrição |
|---|---|
| REST | Modelo arquitetural que consiste de um conjunto coordenado de restrições aplicadas a componentes, conectores e elementos de dados dentro de um sistema distribuído. |
| UTF-8 | Tipo de codificação Unicode de comprimento variável. Pode representar qualquer caractere Unicode, sendo também compatível com o ASCII. |
| JSON | Formato leve para troca de informações entre aplicações. Embora seja um acrônimo para JavaScript Object Notation, pode ser utilizado independentemente de linguagem de programação. |
Verbos HTTP utilizados
Para trabalhar em cada recurso, a integração deverá utilizar os quatro principais verbos do protocolo HTTP:
| Verbo | Objetivo |
|---|---|
| GET | Obter informações sobre determinado recurso (ex: listar clientes, listar notas fiscais). |
| POST | Salvar uma nova instância de um recurso (ex: salvar novo cliente, emitir nova NFCe). |
| PUT | Alterar ou completar informações de um recurso (ex: alterar preço do produto, endereço do cliente). |
| DELETE | Remover uma instância de um recurso (ex: excluir cliente, excluir produto). |
🔐 Segurança
Todas as requisições devem ser autenticadas por um Token, garantindo a segurança dos dados de cada cliente.
-
O Token é único por empresa e pode ser gerado em:
Painel FazNota > Meus Dados > Aba Integração -
Se você possui acesso ao Painel de Gestão de Contas, é possível gerar tokens para cada empresa diretamente por ele.
Cabeçalhos da requisição
Authorization: Token {token da empresa}
Content-Type: application/json
Após isso, defina:
- a URI da requisição,
- o verbo HTTP,
- o corpo da mensagem (se necessário),
- e analise o retorno.
🔗 Endpoint base
Todas as requisições devem ser feitas a partir da seguinte URL base:
https://api.mysebr.com.br/nfemyse-v3/rest/
Status de retorno
| Código | Representação |
|---|---|
| 001 | Realizado o registro de solicitação de emissão para ser executado posteriormente. |
| 002 | Solicitação ainda não processada e se encontra na fila de processamento. |
| 003 | Solicitação está sendo processada neste exato momento. |
| 004 | Emissão realizada com sucesso; documento já se encontra no órgão público responsável. |
| 005 | Solicitação de busca de dados realizada com sucesso. |
| 010 | Cancelamento do documento realizado com sucesso. |
| 050 | Solicitação recusada: número de origem já registrado no sistema. |
| 900 | Emissão recusada pelo órgão público responsável. |
| 999 | Erro interno no sistema ao processar a solicitação. |